Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add interactive tutorial guide to enhance user experience #858

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

iamsherlocked1891
Copy link
Collaborator

@iamsherlocked1891 iamsherlocked1891 commented Jan 23, 2025

Fixes #354

This pull request introduces an interactive tutorial guide to help users better understand and navigate the platform. The tutorial provides step-by-step guidance to address common user challenges and improve onboarding.

Key changes:

  1. New Icon on the Sidebar:
    That new icon was added to the sidebar to trigger the tutorial guide, offering helpful tips on using the platform.
  2. Page-Specific Guides:
    Interactive guides have been developed for the following pages: homepage, model training page, model testing page. Each guide includes detailed steps to walk users through the functionality of the respective page.

The tutorial guides were implemented using the Driver.js library to ensure an intuitive and visually engaging user experience.
A store has been created using Pinia to track when the tutorial guide is needed. This ensures that the tutorial is not displayed repeatedly unless required by the user.

Attached below are several screenshots to visually demonstrate the changes.
homepage
model_trainig_page
model_evaluation_page

@iamsherlocked1891
Copy link
Collaborator Author

Test lint-test-build / test-webapp is failing because, in my previous pull request (where I updated the homepage), changes were made, including modifications to the training.cy.ts test file (webapp/./cypress/e2e/training.cy.ts), where this issue was resolved.

On this branch, the file remains unchanged, which is why the error occurs. Once the changes from the previous pull request are approved and merged, this error will be resolved here as well.

@iamsherlocked1891 iamsherlocked1891 marked this pull request as ready for review January 23, 2025 23:14
Copy link
Collaborator

@tharvik tharvik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the hard work, that looks great and make it way more accessible to everyone 🎉

as per usual, I've left a bunch of comments, tell me if you don't have the time to fix thoses

ho yeah, and FWIW, if you want to base a PR upon another (such as your redesign of the homepage in #845), you can change the base branch by editing this PR. that will fix some duplication and probably allow the CI to pass.

@JulienVig JulienVig self-assigned this Feb 19, 2025
@JulienVig JulienVig force-pushed the interactive-tutorial-olena branch from 400d250 to 10ee9a7 Compare February 26, 2025 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create live tutorial on example task for users
3 participants